Metadata-Version: 2.1
Name: OpenVAS-Reporting
Version: 1.0.1a0
Summary: Convert OpenVAS XML report files to Excel reports.
Home-page: https://github.com/TheGroundZero/openvas_to_report
Author: TheGroundZero
Author-email: 2406013+TheGroundZero@users.noreply.github.com
License: GPL-3.0-or-later
Project-URL: Source Code, https://github.com/TheGroundZero/openvas_to_report
Project-URL: Documentation GitHub, https://openvas-reporting.stijncrevits.be/en/latest/
Project-URL: Issues, https://github.com/TheGroundZero/openvas_to_report/issues/
Description: # OpenVAS Reporting:  
        A tool to convert [OpenVAS](http://www.openvas.org/)/Greenbone XML reports into Excel files.
        
        ![Report example screenshot](docs/_static/img/OpenVASreporting.png?raw=true)
        
        *Read the full documentation at [https://openvas-reporting.stijncrevits.be](https://openvas-reporting.stijncrevits.be)*
        
        I forked [OpenVAS2Report](https://github.com/cr0hn/openvas_to_report) since it didn't manage to convert all reports I threw at it
        and because I wanted to learn how to use Python for working with XML and creating Excel files.  
        Also, OpenVAS mixes their own threat levels with the [CVSS](https://www.first.org/cvss/) scoring, the latter of which I prefer to use in my reports.
        
        Looking for a fix and providing an actual fix through a pull request would have been too much work,
        so I chose to fork the repo and try my own thing.  
        I reorganised some of the files, removed some functionality and added some extra, and rewrote some functions.
        
        At this moment in time, the script only output .xlsx documents in one format, this may (not) change in the future.
        
        ## Requirements
        
         - [Python](https://www.python.org/) version 3
         - [XlsxWriter](https://xlsxwriter.readthedocs.io/)
        
        ## Installation
        
            # install requirements
            apt(-get) install python3 python3-pip # Debian, Ubuntu
            yum -y install python3 python3-pip    # CentOS
            dnf install python3 python3-pip       # Fedora
            pip3 install -r requirements.txt
            # clone repo
            git clone git@github.com:TheGroundZero/openvas_to_report.git
        
        ## Usage
        
            python3 -m openvasreporting -i [OpenVAS xml file(s)] -o [Report output file.xlsx] [-l [minimal threat level (n, l, m, h, c)]]
        
        ### Create Excel report from 1 OpenVAS XML report using default settings
        
            python3 -m openvasreporting -i openvasreport.xml -o excelreport.xlsx
        
        ### Create Excel report from multiple OpenVAS reports using default settings
        
            # wildcard select
            python3 -m openvasreporting -i *.xml -o excelreport.xlsx
            # selective
            python3 -m openvasreporting -i openvasreport1.xml -i openvasreport2.xml -o excelreport.xlsx
        
        ### Create Excel report from multiple OpenVAS reports, reporting only threat level high and up
        
            python3 -m openvasreporting -i *.xml -o excelreport.xlsx -l h
        
        ## Result
        
        The final report will then look something like this:
        
        ![Report example screenshot - Summary](docs/_static/img/screenshot-report.png?raw=true)
        ![Report example screenshot - ToC](docs/_static/img/screenshot-report1.png?raw=true)
        ![Report example screenshot - Vuln desc](docs/_static/img/screenshot-report2.png?raw=true)
        
        Worksheets are sorted according to CVSS score and are colored according to the vulnerability level.
        
        ## Ideas
        
        Some of the ideas I still have for future functionality:
        
         - list vulnerabilities per host
         - make pip installer
         - filter by host (scope/exclude) as in OpenVAS2Report
         - export to other formats (CSV, Word, PDF)
         - select threat levels individually (e.g. none and low; but not med, high and crit)
         
        
Keywords: OpenVAS OpenVAS-reports Excel xlsxwriter xlsx reporting reports report
Platform: UNKNOWN
Requires: xlsxwriter
Description-Content-Type: text/markdown
